[CS2113-W12-4] Fit Track #13

J0shuaLeong · 2023-10-04T05:07:32Z

FitTrack allows users to track meals and workouts, helping them to adjust their diet and exercise to lead a healthy lifestyle. It is optimised for CLI users so that tracking can be done efficiently and easily by typing in commands.

…endar Jingxi-Calendar

NeoMinWei

LGTM, class diagrams can be included as well

NeoMinWei · 2023-11-02T09:09:29Z

docs/DeveloperGuide.md

+
+<div markdown="span" class="alert alert-primary">
+
+:bulb: **Tip:** The '.puml' files used to create the diagrams in this document can be found in [diagrams](./diagrams) 


The :bulb is not showing up correctly

NeoMinWei · 2023-11-02T09:09:58Z

docs/DeveloperGuide.md

+* [**`WorkoutList`**](#workout-list-component): Stores all workouts.
+* [**`Parser`**](#parser-component): Handles user input.
+* [**`Data`**](#data-component): Holds the data of the app in memory.
+* [**`Command`**](#command-component): The command executor.


Links do not work on the website

NeoMinWei · 2023-11-02T09:10:59Z

docs/DeveloperGuide.md

+### Core sequence
+Core sequence of code is written in [`FitTrack`](../src/main/java/fittrack/FitTrack.java) class.
+
+![Core structure](images/FitTrackOuter.svg "Outer Structure")


Possible to remove the bottom object names with hide footbox

NeoMinWei · 2023-11-02T09:11:53Z

docs/DeveloperGuide.md

+
+![Core structure](images/FitTrackOuter.svg "Outer Structure")
+
+![Inner structure](images/FitTrackCore.svg "Core Structure")


For Core Structure, is "do-while" supposed to be "loop" instead?

NeoMinWei · 2023-11-02T09:13:44Z

docs/DeveloperGuide.md

+![Structure of Storage Load](images/StorageLoad.svg)
+The sequence diagram of the code for loading the file contents into each class.
+
+![Structure of Storage Save](images/StorageSave.svg)


For Main Structure of Storage Save, the :FIleWriter on the right is hard to read, maybe choose a different colour?

CerIsaiah · 2023-11-02T09:36:27Z

docs/DeveloperGuide.md

-|v2.0|user|find a to-do item by name|locate a to-do without having to go through the entire list|
+|Version| As a ... | I want to ...                                               | So that I can ...                                             |
+|--------|----------|-------------------------------------------------------------|---------------------------------------------------------------|
+|v1.0|new user| know how to use the product                                 | use the product                                               |


Make the user comments more specific for the things that you want to implement. For example, a user knowing how to run your application doesn't really say much about what needs to be changed or updated

CerIsaiah · 2023-11-02T09:39:12Z

docs/DeveloperGuide.md

+
+
+### Architecture
+{insert diagram to show architecture of code}


Im not sure if I just missed it or its a work in progress but I didn't see the diagram in the initial DG

CerIsaiah · 2023-11-02T09:39:55Z

docs/DeveloperGuide.md


 ### Value proposition

-{Describe the value proposition: what problem does it solve?}
+Fittrack is a health management application which allows users to record their diet and activity, and help them to reach the goal they have set.


This is a really good value proposition, straight to the point

CerIsaiah · 2023-11-02T09:41:46Z

docs/DeveloperGuide.md

+|v2.0|user| see the total calories I have burnt on a particular date    | track my daily calories burnt                                 |
+|v2.0|user| find a meal or workout                                      | quickly search my past meals or workouts                      |
+
+

 ## Non-Functional Requirements

 {Give non-functional requirements}


Is this supposed to be a diagram or are there no non-functional requirements?

YFshadaow · 2023-11-02T09:36:05Z

docs/diagrams/FitTrackCore.puml

+
+main -> main ++: loopCommandExecution()
+
+group do-while [!ExitCommand.isExit(command)]


Is this representation of loop also acceptable? In our textbook the usual representation is "loop"

YFshadaow · 2023-11-02T09:38:04Z

docs/DeveloperGuide.md

+
+<div markdown="span" class="alert alert-primary">
+
+:bulb: **Tip:** The '.puml' files used to create the diagrams in this document can be found in [diagrams](./diagrams) 


The link to diagrams folder is not working

YFshadaow · 2023-11-02T09:39:39Z

docs/diagrams/FitTrackCore.puml

+    main -> ui ++: ui.printCR(commandResult: CR)
+    note left: Print the result of execution
+    note right: CR for CommandResult
+    return


The sequence diagram is generally clear and easy to read!

YFshadaow · 2023-11-02T09:41:36Z

docs/diagrams/StorageLoad.puml

+participant ":WorkoutListDecoder" as wDecoder STORAGE_COLOR_T3
+
+main -> main ++: start()
+activate main MODEL_COLOR


I like the colored representation. It allows readers to differentiate each class more easily.

yicheng-toh

Looks great!

yicheng-toh · 2023-11-02T09:43:26Z

docs/images/FitTrackCore.svg

Perhaps the footer box can be removed.

yicheng-toh · 2023-11-02T09:44:00Z

docs/images/FitTrackCore.svg

Perhaps the word 'loop' can be used instead.

yicheng-toh · 2023-11-02T09:48:09Z

docs/images/StorageSave.svg

Perhaps this could be 'elements in mealArr' instead.

Modify codes and UG

Fix profile loading bug

…ravelled

…n a list form

…date

…the date

…st to a txt file

Add sequence diagrams

Resolves #60

Update UG

Update DG

Update DG PPP

Update AboutUs.md

# Conflicts: # docs/DeveloperGuide.md

Update DG Final

Update PPP

Update PPP for Nixon

Brian030601 added a commit to Brian030601/tp that referenced this pull request Oct 17, 2023

Merge pull request nus-cs2113-AY2324S1#13 from Cheezeblokz/Jingxi-Cal…

5469535

…endar Jingxi-Calendar

NeoMinWei reviewed Nov 2, 2023

View reviewed changes

CerIsaiah reviewed Nov 2, 2023

View reviewed changes

YFshadaow reviewed Nov 2, 2023

View reviewed changes

yicheng-toh reviewed Nov 2, 2023

View reviewed changes

ICubE- and others added 25 commits November 4, 2023 17:37

Refactor UG

3b9d3f1

Resolve few warnings

2289407

Modify FindXXXCommand not to use extra Ui instance

b769182

Fix typo

ff410cd

Fix test and maintain style

e963178

Maintain style

09dfee7

Merge remote-tracking branch 'upstream/master'

d21204d

Update UG

3245729

Fix test

c61aecd

Merge pull request #220 from ICubE-/master

59cbea2

Modify codes and UG

Fix profile loading bug

da48e35

Merge pull request #225 from ICubE-/fix-bug-and-maintain-style

4c2be5d

Fix profile loading bug

Create new class to hold the list of steps

053956f

Create new class for command to add steps to the list

47cd9c4

Create new class for command to calculate the total number of steps t…

50fdcda

…ravelled

Create a new class for command to view the steps entered and stored i…

b52c159

…n a list form

Create a new class to hold data for a single step entry

8ce97bb

Create a new class to manage the decoding of steps in the txt file

fd95365

Modify method parameters to include stepList functionalities

3bc961d

Create a new method to fetch the Calories Burnt and manually set the …

e69ef14

…date

Create a new method to fetch the Calories Consummed and manually set …

0ade10b

…the date

Update switch branch to include check for the new commands

1018cdc

Update exit command functionalities to include caching of the step li…

888c20c

…st to a txt file

Update save command functionalities to include caching of the step li…

4fe9e67

…st to a txt file

Update switch branch to include check for the new commands

38fe527

farissirraj and others added 30 commits November 13, 2023 23:02

UG Update

4dab12a

Merge pull request #274 from farissirraj/master

dcbb555

Add sequence diagrams

Update DG

474668b

Remove Unused Storage test

e0f8189

All possible inputs

2a11ea1

Resolves #60

Merge branch 'master' of https://github.com/AY2324S1-CS2113-W12-4/tp

23622a3

Update UG

894363a

Merge pull request #278 from J0shuaLeong/master

7206485

Update UG

Write DG Help Function

93564a7

Fix diagrams

cb5f347

Merge pull request #279 from ICubE-/master

614709f

Update DG

Update DG

84c5ead

Update DG

14c5480

Update PPP

6a79d13

Merge remote-tracking branch 'upstream/master'

1811a7e

Merge pull request #280 from ICubE-/master

bc625db

Update DG PPP

Update AboutUs.md

22908dd

Merge pull request #281 from ICubE-/master

5f08248

Update AboutUs.md

Update DG

d019322

Update UG

ad270e9

Edit caloriebalance sequence diagram

9742fe7

Merge branch 'master' of https://github.com/AY2324S1-CS2113-W12-4/tp

041fce6

# Conflicts: # docs/DeveloperGuide.md

Update DG and add sequence diagrams

2912b47

Update DG

c4d0043

Merge pull request #282 from J0shuaLeong/master

07f78cf

Update DG Final

Update PPP

5edbc38

Merge pull request #283 from J0shuaLeong/master

cc40917

Update PPP

Update PPP for Nixon

74bb39a

Merge pull request #284 from J0shuaLeong/master

ab958d0

Update PPP for Nixon

added ppp (#285)

ccac196

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CS2113-W12-4] Fit Track #13

[CS2113-W12-4] Fit Track #13

J0shuaLeong commented Oct 4, 2023

NeoMinWei left a comment

NeoMinWei Nov 2, 2023

NeoMinWei Nov 2, 2023

NeoMinWei Nov 2, 2023

NeoMinWei Nov 2, 2023 •

edited

Loading

NeoMinWei Nov 2, 2023 •

edited

Loading

CerIsaiah Nov 2, 2023

CerIsaiah Nov 2, 2023

CerIsaiah Nov 2, 2023

CerIsaiah Nov 2, 2023

YFshadaow Nov 2, 2023

YFshadaow Nov 2, 2023

YFshadaow Nov 2, 2023

YFshadaow Nov 2, 2023

yicheng-toh left a comment

yicheng-toh Nov 2, 2023

yicheng-toh Nov 2, 2023

yicheng-toh Nov 2, 2023


		<div markdown="span" class="alert alert-primary">

		:bulb: Tip: The '.puml' files used to create the diagrams in this document can be found in [diagrams](./diagrams)


		![Core structure](images/FitTrackOuter.svg "Outer Structure")

		![Inner structure](images/FitTrackCore.svg "Core Structure")



		### Architecture
		{insert diagram to show architecture of code}


		main -> main ++: loopCommandExecution()

		group do-while [!ExitCommand.isExit(command)]

[CS2113-W12-4] Fit Track #13

Are you sure you want to change the base?

[CS2113-W12-4] Fit Track #13

Conversation

J0shuaLeong commented Oct 4, 2023

NeoMinWei left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NeoMinWei Nov 2, 2023 • edited Loading

Choose a reason for hiding this comment

NeoMinWei Nov 2, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yicheng-toh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NeoMinWei Nov 2, 2023 •

edited

Loading

NeoMinWei Nov 2, 2023 •

edited

Loading